Skip to content

Create static GitHub Copilot instructions file and restore environment setup workflow#771

Merged
BenjaminMichaelis merged 11 commits intomainfrom
copilot/fix-fde5fa8c-b82a-4f64-b892-775e442dc677
Aug 29, 2025
Merged

Create static GitHub Copilot instructions file and restore environment setup workflow#771
BenjaminMichaelis merged 11 commits intomainfrom
copilot/fix-fde5fa8c-b82a-4f64-b892-775e442dc677

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 27, 2025

This PR addresses feedback to properly separate concerns between environment setup and documentation:

What Changed

  1. Created static copilot-instructions.md file - A comprehensive documentation file committed directly to the repository following GitHub Copilot best practices

  2. Restored workflow to environment setup focus - The copilot-setup-steps.yml workflow now focuses solely on setting up the development environment needed to run the application

The Copilot Instructions File

The .github/copilot-instructions.md file provides comprehensive documentation for GitHub Copilot agents including:

  • Project Overview: Essential C# web platform architecture and purpose
  • Tech Stack Details: .NET 9, ASP.NET Core, Semantic Kernel, Entity Framework, Docker
  • Development Patterns: Coding conventions, file organization, dependency injection patterns
  • Testing Strategy: xUnit setup, testing frameworks, and AAA pattern conventions
  • Build Commands: Essential dotnet commands for development and deployment
  • Configuration Guide: Required secrets, user-secrets setup, OAuth configuration
  • AI Integration: Semantic Kernel patterns, vector database usage, chat services
  • Best Practices: Security guidelines, performance considerations, anti-patterns

Environment Setup Workflow

The workflow now focuses exclusively on preparing the development environment with:

  • .NET 9.0 SDK with private NuGet feed access
  • Docker containerization setup and validation
  • Azure CLI and GitHub CLI tools
  • Entity Framework Core CLI tools
  • Node.js for frontend development
  • Comprehensive testing and validation of all tools

This separation ensures the workflow serves its intended purpose of environment preparation while the instructions file provides static, comprehensive documentation that Copilot agents can reference for accurate code generation.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits August 27, 2025 16:22
Co-authored-by: BenjaminMichaelis <22186029+BenjaminMichaelis@users.noreply.github.com>
…ctions

Co-authored-by: BenjaminMichaelis <22186029+BenjaminMichaelis@users.noreply.github.com>
Co-authored-by: BenjaminMichaelis <22186029+BenjaminMichaelis@users.noreply.github.com>
Copilot AI changed the title [WIP] preconfigure Copilot's environment before the agent starts by creating a special GitHub Actions workflow file, located at .github/workflows/copilot-setup-steps.yml within your repository. Use the docs here: https://docs.github.com/en/copilot/how-tos/u... Add GitHub Copilot agent environment setup workflow Aug 27, 2025
Comment thread .github/workflows/copilot-setup-steps.yml Outdated
Co-authored-by: BenjaminMichaelis <22186029+BenjaminMichaelis@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Aug 27, 2025

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • gh.io
    • Triggering command: curl -s REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title Add GitHub Copilot agent environment setup workflow Generate GitHub Copilot instructions file for repository setup Aug 27, 2025
…orkflow

Co-authored-by: BenjaminMichaelis <22186029+BenjaminMichaelis@users.noreply.github.com>
Copilot AI changed the title Generate GitHub Copilot instructions file for repository setup Create static GitHub Copilot instructions file and restore environment setup workflow Aug 27, 2025
Comment thread .github/workflows/copilot-setup-steps.yml Outdated
Comment thread .github/workflows/copilot-setup-steps.yml Outdated
Comment thread .github/workflows/copilot-setup-steps.yml Outdated
Comment thread .github/workflows/copilot-setup-steps.yml Outdated
@BenjaminMichaelis BenjaminMichaelis marked this pull request as ready for review August 29, 2025 06:40
@BenjaminMichaelis BenjaminMichaelis merged commit c6568e1 into main Aug 29, 2025
5 checks passed
@BenjaminMichaelis BenjaminMichaelis deleted the copilot/fix-fde5fa8c-b82a-4f64-b892-775e442dc677 branch August 29, 2025 15:36
BenjaminMichaelis added a commit that referenced this pull request Apr 25, 2026
…t setup workflow (#771)

This PR addresses feedback to properly separate concerns between
environment setup and documentation:

## What Changed

1. **Created static `copilot-instructions.md` file** - A comprehensive
documentation file committed directly to the repository following
[GitHub Copilot best practices](https://gh.io/copilot-coding-agent-tips)

2. **Restored workflow to environment setup focus** - The
`copilot-setup-steps.yml` workflow now focuses solely on setting up the
development environment needed to run the application

## The Copilot Instructions File

The `.github/copilot-instructions.md` file provides comprehensive
documentation for GitHub Copilot agents including:

- **Project Overview**: Essential C# web platform architecture and
purpose
- **Tech Stack Details**: .NET 9, ASP.NET Core, Semantic Kernel, Entity
Framework, Docker
- **Development Patterns**: Coding conventions, file organization,
dependency injection patterns
- **Testing Strategy**: xUnit setup, testing frameworks, and AAA pattern
conventions
- **Build Commands**: Essential dotnet commands for development and
deployment
- **Configuration Guide**: Required secrets, user-secrets setup, OAuth
configuration
- **AI Integration**: Semantic Kernel patterns, vector database usage,
chat services
- **Best Practices**: Security guidelines, performance considerations,
anti-patterns

## Environment Setup Workflow

The workflow now focuses exclusively on preparing the development
environment with:

- .NET 9.0 SDK with private NuGet feed access
- Docker containerization setup and validation
- Azure CLI and GitHub CLI tools
- Entity Framework Core CLI tools
- Node.js for frontend development
- Comprehensive testing and validation of all tools

This separation ensures the workflow serves its intended purpose of
environment preparation while the instructions file provides static,
comprehensive documentation that Copilot agents can reference for
accurate code generation.

<!-- START COPILOT CODING AGENT SUFFIX -->



<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: BenjaminMichaelis <22186029+BenjaminMichaelis@users.noreply.github.com>
Co-authored-by: Benjamin Michaelis <git@relay.benjamin.michaelis.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants